<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>[Generic Component Framework v3] GCF::IGDriveLiteAuthenticator Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<!--link href="tabs.css" rel="stylesheet" type="text/css"-->
</head><body>
 <div id="wrapper">
    <div id="logo_box">
        <a class="img_link" href="https://github.com/pnudupa/gcf" target="_blank" ><img style="float:left;margin-left:10px;margin-top:5px;margin-bottom:5px;"src="header_gcf_logo.jpg" alt="GCF LOGO"/></a>
        <a class="img_link" href="https://www.vcreatelogic.com/" target="_blank" ><img style="float:right;margin-right:10px; margin-top: 30px;" src="header_vcl_logo.jpg" alt="VCL LOGO"/></a>
        <div style="clear:both"></div>
    </div>
    <div class="nav">
        <ul>
            <li class="selectedpage">
                <a class="a-home" href="index.html" >
                    <span>Home</span>
                </a>
            </li>
            <li>
                <a class="a-classes " href="classes.html">
                    <span>All Classes</span>
                </a>
            </li>
            <li>
                <a class="a-home " href="gcf_modules.html">
                    <span>Modules</span>
                </a>
            </li>
            <li>
                <a class="a-home " href="gcf_guides_and_videos.html">
                    <span>Guides & Videos</span>
                </a>
            </li>
            <li>
                <a class="a-home " href="gcf_tools_and_inbuilt_components.html">
                    <span>Tools & Components</span>
                </a>
            </li>
        </ul>
    </div>
    <div id="main-content">
        <div class="inside">
        <div>
<!-- Generated by Doxygen 1.8.16 -->
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><b>GCF</b></li><li class="navelem"><a class="el" href="class_g_c_f_1_1_i_g_drive_lite_authenticator.html">IGDriveLiteAuthenticator</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_g_c_f_1_1_i_g_drive_lite_authenticator-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">GCF::IGDriveLiteAuthenticator Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span><div class="ingroups"><a class="el" href="group__gcf__gdrivelite.html">GCF's GDriveLite component</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>This is class helps the user to authenticate..  
 <a href="class_g_c_f_1_1_i_g_drive_lite_authenticator.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a3b13a7f54ae6377963143813f2987d46"><td class="memItemLeft" align="right" valign="top">virtual QUrl&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_i_g_drive_lite_authenticator.html#a3b13a7f54ae6377963143813f2987d46">authenticationPageUrl</a> () const =0</td></tr>
<tr class="separator:a3b13a7f54ae6377963143813f2987d46"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a800aeb2ee1362869733e1ebeacf7fe65"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_g_c_f_1_1_result.html">GCF::Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_i_g_drive_lite_authenticator.html#a800aeb2ee1362869733e1ebeacf7fe65">authenticateFromPageTitle</a> (const QString &amp;title, QObject *notifyObject=0, const char *notifySlot=0)=0</td></tr>
<tr class="separator:a800aeb2ee1362869733e1ebeacf7fe65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c2f01f20578e2ab638e4d3272364b5e"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_g_c_f_1_1_result.html">GCF::Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_c_f_1_1_i_g_drive_lite_authenticator.html#a2c2f01f20578e2ab638e4d3272364b5e">refreshAuthentication</a> ()=0</td></tr>
<tr class="separator:a2c2f01f20578e2ab638e4d3272364b5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p> 
<pre>
#include &lt;GCF3/IGDriveLiteAuthenticator&gt;
</pre>
</p>
<p>There will be only one instance of <a class="el" href="class_g_c_f_1_1_i_g_drive_lite_authenticator.html">GCF::IGDriveLiteAuthenticator</a> in GDrive component . You will have to set the client ID and client-secret inorder for authenticator to give proper url for authentication. For Details about client ID and other things please refer to <a class="el" href="group__gcf__gdrivelite.html">GCF's GDriveLite component</a>.</p>
<p>Once instantiated, you will need to authorize <a class="el" href="class_g_c_f_1_1_i_g_drive_lite.html">GCF::IGDriveLite</a> to access the drive content and work with it. Read <a class="el" href="group__gcf__gdrivelite.html#gcf_gdrivelite_2">Authorising GDriveLite to access drive data</a> for more details.</p>
<p>Access tokens are automatically refreshed, but you can trigger it manually using <a class="el" href="class_g_c_f_1_1_i_g_drive_lite_authenticator.html#a2c2f01f20578e2ab638e4d3272364b5e">GCF::IGDriveLiteAuthenticator::refreshAuthentication()</a> also. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a3b13a7f54ae6377963143813f2987d46"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3b13a7f54ae6377963143813f2987d46">&#9670;&nbsp;</a></span>authenticationPageUrl()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">GCF::IGDriveLiteAuthenticator::authenticationPageUrl </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Returns authentication Url which should be loaded into a web page and shown to user to enter his/her credentials.</p>
<dl class="section return"><dt>Returns</dt><dd><code>QUrl</code> which needs to be shown to the user for authentication. </dd></dl>

</div>
</div>
<a id="a800aeb2ee1362869733e1ebeacf7fe65"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a800aeb2ee1362869733e1ebeacf7fe65">&#9670;&nbsp;</a></span>authenticateFromPageTitle()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">GCF::IGDriveLiteAuthenticator::authenticateFromPageTitle </td>
          <td>(</td>
          <td class="paramtype">const QString &amp;&#160;</td>
          <td class="paramname"><em>title</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">QObject *&#160;</td>
          <td class="paramname"><em>notifyObject</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>notifySlot</em> = <code>0</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>This method gets access token from the changed authentication url after user has authenticated.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">title</td><td>the changed url after user authentication which contains the success code. </td></tr>
    <tr><td class="paramname">notifyObject</td><td>object to notify once the access token is retrieved by authenticator. </td></tr>
    <tr><td class="paramname">notifySlot</td><td>slot to notify in the notifyObject once the access token retrieved by authenticator. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_g_c_f_1_1_result.html">GCF::Result</a> which contains success or failure based on whether sending request for access token was successful or not. </dd></dl>

</div>
</div>
<a id="a2c2f01f20578e2ab638e4d3272364b5e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c2f01f20578e2ab638e4d3272364b5e">&#9670;&nbsp;</a></span>refreshAuthentication()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">GCF::IGDriveLiteAuthenticator::refreshAuthentication </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Refreshes the access token. For refreshing authentication the user must have been authenticated at least once. </p><dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_g_c_f_1_1_result.html">GCF::Result</a> which contains success or failure based on whether sending request for refreshing was successful or not. </dd></dl>

</div>
</div>
</div><!-- contents -->
</div>
</div>
</div>
<div class="footer_content">
<table width="100%" class="footer">
<tr>
<td align="left" width="50%">Copyright &copy; 2013-2019,
 <a class="el" href="http://www.vcreatelogic.com" target="_black">VCreate Logic Private Limited</a></td>
<td align="right" width="50%"><a class="el" href="http://www.vcreatelogic.com/products/gcf" target="_black">GCF - Generic Component Framework</a></td>
</tr>
</table>
</div>
</div>
</body>
</html>
